home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / 2dapt131.arc / 2DAPOINT.DOC < prev    next >
Text File  |  1991-10-03  |  10KB  |  259 lines
  1. 2DaPoint                                                                Page 1
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                        ╓─╖  ╥─┐  ╓─┐  ╥─┐  ╓─┐  ╥  ╥─┐  ─┬─
  8.                        ╓─╜  ║ │  ╟─┤  ╟─┘  ║ │  ║  ║ │   │
  9.                        ╙──  ╨─┘  ╜ └  ╨    ╙─┘  ╨  ╨ ┴   ┴
  10.                       Version 1.30 Reference Guide  09/1991
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.            A totally free mail bundler for FTSC compliant .MSG files.
  20.  
  21.  
  22.  
  23.              Software & documentation by Ron Pritchett of 1:376/74
  24.  
  25.  
  26.  
  27.                     Copyright (c) 1991 Realm Software
  28.                            All Rights Reserved
  29.  
  30.  
  31.  
  32.                             Realm Software
  33.                            133 WaterView Dr
  34.                           Columbia, SC 29212
  35.  
  36.  
  37. 2DaPoint                                                                Page 2
  38.  
  39.  INTRODUCTION
  40.  
  41.    This software was written on a whim. After noticing how well Maximus
  42.  CBCS handles point addressing, I started searching for an equally
  43.  point-aware NetMail Bundler. The idea is that the average caller/user
  44.  shouldn't have to know anything about the pseudo point network/secondary
  45.  set of addresses. The only thing I found that came close was REMAPPER by
  46.  Bob Hartman (of ConfMail fame), but this didn't work quite the way I
  47.  wanted it to & lacked a few features. Finally I downloaded a copy of the
  48.  FTSC specs & went to work on my own program. Here it is.
  49.  
  50.  
  51.  WHAT IT DOES
  52.  
  53.   - Full zone support.
  54.  
  55.   - Complete Message bundling (.?UT file generator) for normally addressed
  56.     messages including File Requests, File Attaches, Forwarding, Crash,
  57.     Hold, & Kill. (ie the whole 9 yards)
  58.  
  59.   - Through File Attaches between points or BBSes which can optionally be
  60.     deleted once sent. Multiple File Attaches & File Requests are supported
  61.     too.
  62.  
  63.   - Recognition of point addresses embedded within messages to send the
  64.     message to the proper host or pointnet address.
  65.  
  66.   - Address redirection (including points) via name recognition.
  67.  
  68.   - Name remapping via alias name recognition.
  69.  
  70.   - Origin address remapping for messages coming from a pointnet address &
  71.     bound elsewhere.
  72.  
  73.   - Correclty packs up any echomail in your NetMail that's bound for another
  74.     node without altering it. (EchoMail is denoted by the ^APATH Kludge)
  75.  
  76.  WHAT IT DOESN'T DO
  77.  
  78.   - It won't do XRobot-type automatic mailings/file attaches.
  79.  
  80.   - It won't balance your checkbook.
  81.  
  82.   - It won't fix your recently pedestrian-damaged Buick Impala for free or
  83.     even at a discount rate.
  84.  
  85.  
  86. 2DaPoint                                                                Page 3
  87.  
  88. CONTROL FILE
  89.  
  90.   2DaPoint requires the presence of a control file called 2DAPOINT.CTL
  91. which must reside in the same directory the executable program is. There
  92. is no way/reason to have the control file named anything else.
  93.  
  94.   A sample configuration file with internal documentation is included. The
  95. sample is actually MY control file. It's short & sweet. Not too many options
  96. or things to go wrong. 2DaPoint is very forgiving about the information
  97. contained in the control file. If information is missing or invalid, the
  98. program will point out which additional information is needed/invalid.
  99.  
  100. The commands are listed here in alphabetical order for reference ease.
  101.  
  102.   ADDRESS <(zone:)net/node(.point)>
  103.  
  104.           Here your full address must be specified. Zone & point are not
  105.           a required portion of the address; zone 1 is assumed & .0 is
  106.           also assumed. The point portion of the address is recognized,
  107.           but is only for future expansion. It may possible to run this
  108.           program from a point system, but I haven't tried it.
  109.  
  110.   FILEFWD <Kill | Save>
  111.  
  112.           This options controls whether or not a file passing thru
  113.           your node is to be killed or saved. If 'Kill' is specified,
  114.           then file will be killed by your mailer after it has been sent.
  115.           If 'Save' is specified, the file will not be killed, it'll just
  116.           sit in your inbound directory. NOTE: This only applies to
  117.           passthru files (ie they didn't originate from your node & they're
  118.           not destine to your node).
  119.  
  120.   FORWARD <Kill | Save>
  121.  
  122.           This options controls whether or not a message passing thru
  123.           your node is to be killed or saved. If 'Kill' is specified,
  124.           then message will be packed up & then the .MSG file will
  125.           be erased. If 'Save' is specified, the message will not be killed
  126.           just marked as 'Sent'.
  127.  
  128.   INBOUND <directory>
  129.  
  130.           This is the path of your incoming file/mail directory. This is
  131.           used for passthru file attaches for your node. This way points
  132.           can send mail amongst themselves via your host or even to other
  133.           nodes or other points on other nodes.
  134.  
  135.           For Example, when a point sends a file to another point, the
  136.           subject line of the message contains the path & filename of the
  137.           file to be sent. Well, there's only a one in a million chance that
  138.           this will be the same on the both the point's & Host's computer.
  139.           2DaPoint will replace the path on the incoming message with the
  140.           directory name that you have specified. (ie where the file is now
  141.           located on the host system.)
  142.  
  143.   MAIL <directory>
  144.  
  145.           This is the path to your netmail messages directory. 2DaPoint
  146.           looks here for messages that need to be sent, etc.
  147.  
  148.  
  149. 2DaPoint                                                                Page 4
  150.  
  151.   MODE <Net | Node>
  152.  
  153.           This option controls when a message bound for a point is
  154.           readdressed to it's pointnet address. If operating in 'Net'
  155.           mode, any mail bound for a point in your zone & network will be
  156.           packed up for it pointnet address (ie ZONE:POINTNET/POINT#.0).
  157.  
  158.           If operating in 'Node' mode, the additional constraint of a point
  159.           being your point is added. If a message is received for your
  160.           point, then (as above) it is bundled to ZONE:POINTNET/POINT#.0.
  161.           Otherwise, the message is sent to that point's host which would be
  162.           another node in your network. Once there the ^ATOPT would be
  163.           recognized & the message would be sent along the proper path.
  164.           Also see POINTNET.
  165.  
  166.   NAMES
  167.           This marks the beginning of your name service addressing. One
  168.           name & address appear per line until the keyword END is
  169.           encoutered. If a message is bound for a node in your Network
  170.           or your PointNet and the name is in the control file, then the
  171.           destination in the control file is used instead of the one
  172.           embedded in the message. (Read that sentence again, I'm sure
  173.           it'll be the source of some confusion. <grin> )
  174.  
  175.           The syntax of the NAMES block is:
  176.  
  177.           Names
  178.             ( <alias1> ^) <name 1>  <address>
  179.             ( <alias2> ^) <name 2>  <address>
  180.             ........  .........
  181.             ( <aliasx> ^) <name x>  <address>
  182.           End
  183.  
  184.           Where <name> can be any numbers of words (theoretically). And
  185.           <address> is a full or partial address. "What's a partial
  186.           address?" you're asking. Well basically it means that the part
  187.           of the address that you don't explicitly enter, will be assumed
  188.           based upon what address you have specified for your address via
  189.           the ADDRESS statement. See examples in control file.
  190.  
  191.           If an <alias> is present, then any message addressed to
  192.           <alias> or <name> will be sent to <name> @ <address>. The ^
  193.           character delimites between the <alias> & <name>. See example
  194.           control file for examples that might wipe away your confusion. <g>
  195.  
  196.           Also: the <address> may be "Hold" which will simply hold the
  197.           message and not send it anywhere.
  198.  
  199.   OUTBOUND <directory>
  200.  
  201.           This is the path to your outbound mail directory. All generated
  202.           outbound bundles/packets will be placed in this directory.
  203.  
  204.   POINTNET <net>
  205.  
  206.           This is the number of the pseudo point network for your
  207.           regular network. For Example, Net 1:376's is 30122. Any
  208.           outgoing message for your network with a ^ATOPT embedded
  209.           point address will be bundled for ZONE:POINTNET/POINT#.0
  210.           or it's full 4D addressed based upon which MODE you are
  211.           using. Also see MODE for more on this.
  212.  
  213.  
  214. 2DaPoint                                                                Page 5
  215.  
  216. COMMAND LINE PARAMETERS
  217.  
  218.  -B  = Use BIOS calls instead of direct video writes.
  219.  
  220. READRESSING
  221.  
  222.   Just a few quick words on the way 2DaPoint handles point/pointnet addresses
  223.   on inbound messages:
  224.  
  225.   - If a message comes from a point with is full address specified
  226.     (ie, a ^AFMPT is embedded in the message), nothing happens.
  227.  
  228.   - If a message comes from a point, but has the PointNet origin address,
  229.     the origin address it changed to your address. The ^AMSGID it also
  230.     changed to read the full 4D address and then the ^AFMPT is added.
  231.     (Not to mention a nifty litte "via" line.)
  232.  
  233.  
  234.   NOTE: These changes occurr to the outbound packet file, the message (.MSG)
  235.         file remains unchanged.
  236.  
  237.  
  238. LEGAL STUFF
  239.  
  240.   I take no reponsibility for what this program will do. It is NOT a trojan
  241. horse type program, but who knows what could happen with an incompetent user.
  242.  
  243.  
  244. CLOSING THOUGHTS
  245.  
  246.   This program has been thoroughly tested with Maximus & should work on Fido,
  247. Opus & any other FTSC-compliant BBSwares. Please report any problems
  248. encountered, if any. The lastest version can be F'req from 1:376/74 with
  249. the magic filename of 2DAPOINT.
  250.  
  251.   That's it! I'm not much on docs. I'd love to hear from you. If you thought
  252. this software is trash, helpful, lacking in a few areas, whatever!
  253.  
  254.  
  255.  
  256.  
  257.                                                   Ron Pritchett
  258.                                                   1:376/74
  259.